Skip to main content

​
Introduction

This document introduces an advanced feature: how to provide a public URL via the Jogg.ai API to have the system automatically extract content, generate a summary, and ultimately create a digital avatar narration video.

​
Core Concept: Automated Content Creation Workflow

This feature is designed to automate content processing. You only need to provide a link to the content, and our AI system will handle all subsequent work.
  1. Submit URL: You provide a publicly accessible URL via the API (e.g., a news article, blog post, or Amazon/Shopify/ebay/Tiktok product link).
  2. Content Extraction & Analysis: The Jogg.ai server will visit the URL and intelligently extract the core text or video script content.
  3. AI-Generated Summary: Our artificial intelligence model will condense the extracted content into a summary script suitable for video narration.
  4. Video Synthesis: The system uses your specified digital avatar and voice to automatically generate a complete video based on the summary script.
  5. Asynchronous Notification: Like all video creation tasks, this is an asynchronous process. Once the task is complete, we will notify you of the result via a webhook.

​
Quick Start

​
Prerequisite

  • You need a JoggAI account with API access.
  • You need to go through the  Get your API key

​
Main Steps

Generate a video in the following four steps:
  1. Upload the URL to create the product and analyze the URL to retrieve product information. Or directly upload product information.
  2. Update the product information if necessary(Optionally).
  3. Initiate video generation based on the product, with the option to adjust video settings.
  4. Get the generated video.

​
Upload URL / Product info to create product

Upload the URL to create the product and analyze the URL to retrieve product information. Or directly upload product information. Please refer to the Upload URL to create product for more details. 
curl --request POST \
  --url https://api.jogg.ai/v1/product \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "url": "https://res.jogg.ai.com/product_url", // Not required, if it is filled, the following product information will not take effect.
  // If the above URL is not specified, the following product information takes effect. name, description, and media are required parameters.
  "name": "Physicians Formula Happy Booster Heart Blush Glow &amp;amp; Mood Boosting, Rose, Dermatologist Tested",
  "description": "Brush on a radiant blushing glow: Ultra-soft and blendable blushing powder features a fresh and vibrant mix of blushing tones infused with a pop of color to create a healthy glow. Multi-reflective pearls provide a soft iridescence to highlight contour and add radiance to cheeks. Experience the mood boosting effect: Infused with our Happy Boost Blend featuring Happy Skin and Euphoryl, natural plant extracts which have been shown to promote a feeling of happiness by mimicking the effect of Endorphins and helping protect the skin from environmental stress. ",
  "target_audience": "",
  "media": [
    {
      "type": 1,
      "name": "media.jpg",
      "url": "https://res.jogg.ai/media.jpg",
      "description": "Brush on a radiant blushing glow: Ultra-soft and blendable blushing powder features a fresh and vibrant mix of blushing tones infused with a pop of color to create a healthy glow."
    }
  ]
  
}
Response example: 
{
    "rid": "d43b3a5999e31b7e7a62ee5ef84d411d",
    "code": 0,
    "msg": "success",
    "data": {
        "product_id": "NTQ0MTkzNjg",
        "url": "https://www.amazon.com/Physicians-Formula-Happy-Booster-Boosting/dp/B004HYNCA0/ref=pd_pss_dp_d_1_d_sccl_2_5/138-8774804-7229638?pd_rd_w=Tv0XC&content-id=amzn1.sym.427cdbb1-779c-4be6-8c9b-81ddadc2ade4&pf_rd_p=427cdbb1-779c-4be6-8c9b-81ddadc2ade4&pf_rd_r=D8HMAN0M29D09GNV840V&pd_rd_wg=cQL8r&pd_rd_r=ea6b53cb-04b0-4b85-977d-a74804551bd8&pd_rd_i=B004HYNCA0&psc=1",
        "name": "Physician Tested update",
        "description": "Brush on a radiant blushing glow: Ultra-soft and blendable blushing powder features a fresh and vibrant mix of blushing tones infused with a pop of color to create a healthy glow. Multi-reflective pearls provide a soft iridescence to highlight contour and add radiance to cheeks.",
        "media": [
            {
                "type": 2,
                "name": "c7131c6d03cf0e5df33f7db8f1176c32.mp4",
                "url": "https://res.jogg.ai/c7131c6d03cf0e5df33f7db8f1176c32.mp4",
                "description": ""
            },
            {
                "type": 1,
                "name": "Image2",
                "url": "https://res.jogg.ai/2484eeeac5ae6360284fa2f04f1a2691.jpg",
                "description": "This product offers versatile blush shades in \"Rose\" and \"Natural,\" suitable for diverse skin tones, enhancing a natural, radiant look for makeup enthusiasts."
            },
            {
                "type": 1,
                "name": "Image3",
                "url": "https://res.jogg.ai/a6e523fb48f0ac488dae85578c30e2ab.jpg",
                "description": "Heart-themed blush compacts offer a satin finish with a rose-tinted glow, perfect for enhancing a natural or rosy complexion for beauty enthusiasts."
            },
            {
                "type": 1,
                "name": "Image4",
                "url": "https://res.jogg.ai/ed39da987c4c513b15f1a4915b033175.jpg",
                "description": "Heart-themed blush with mood-boosting violet scent, includes brush and mirror for convenient application, ideal for enhancing complexion and uplifting spirits."
            }
        ],
        "target_audience": ""
    }
}

​
Update Product Information(Optional)

Update the product information if necessary(Optionally). Please refer to the Update Product Information for more details. 
curl --location --request PUT 'https://api.jogg.ai/v1/product' \
--header 'x-api-key: <your-api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
        "product_id": "NTQ0MTkzNjg",
        "name": "Physician Tested update",
        "description": "Brush on a radiant blushing glow: Ultra-soft and blendable blushing powder features a fresh and vibrant mix of blushing tones infused with a pop of color to create a healthy glow. Multi-reflective pearls provide a soft iridescence to highlight contour and add radiance to cheeks. 
        "media": [
            {
                "type": 2,
                "name": "c7131c6d03cf0e5df33f7db8f1176c32.mp4",
                "url": "https://res.jogg.ai/c7131c6d03cf0e5df33f7db8f1176c32.mp4",
                "description": ""
            },
            {
                "type": 1,
                "name": "Image2",
                "url": "https://res.jogg.ai/2484eeeac5ae6360284fa2f04f1a2691.jpg",
                "description": "This product offers versatile blush shades in \"Rose\" and \"Natural,\" suitable for diverse skin tones, enhancing a natural, radiant look for makeup enthusiasts."
            },
            {
                "type": 1,
                "name": "Image3",
                "url": "https://res.jogg.ai/a6e523fb48f0ac488dae85578c30e2ab.jpg",
                "description": "Heart-themed blush compacts offer a satin finish with a rose-tinted glow, perfect for enhancing a natural or rosy complexion for beauty enthusiasts."
            },
            {
                "type": 1,
                "name": "Image4",
                "url": "https://res.jogg.ai/ed39da987c4c513b15f1a4915b033175.jpg",
                "description": "Heart-themed blush with mood-boosting violet scent, includes brush and mirror for convenient application, ideal for enhancing complexion and uplifting spirits."
            }
        ],
        "target_audience": ""
}'

​
Generate Video from Product Information

Please refer to the Generate Video from Product Information for more details.

​
With Visual Style

Initiate a video generation task, where you can adjust video-related parameters and modify the video’s layout by selecting a visual style. You can view Get Visual Style for more details. 
curl --location --request POST 'https://api.jogg.ai/v1/create_video_from_url' \
--header 'x-api-key: <your-api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "product_id": "NTQ0MTkzNjg",
    "aspect_ratio": 0,
    "video_length":"15",
    "language": "english",
    "avatar_id": 127,
    "avatar_type":0,
    "visual_style": "FullScreen",
    "script_style": "Don't Worry",
    "voice_id":"en-US-ChristopherNeural",
    "music_id": 62,
    "template_type": "public",
    "override_script": "",
    "caption": true,
	"video_name":"my_video"
    }
Response example: 
{
    "rid": "864ecc09edbc22041a7312fb4ffb0cd2",
    "code": 0,
    "msg": "success",
    "data": {
        "project_id": "7321782d69884a869400beb255e3ca91"
    }
}

​
With Template

Initiate a video generation task where you can adjust video-related parameters and customize the video’s style and appearance by selecting a template. You can view Get Template List from Library for more details. 
curl --location --request POST 'https://api.jogg.ai/v1/create_video_from_url' \
--header 'x-api-key: <your-api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "product_id": "NTQ0MTkzNjg",
    "aspect_ratio": 0,
    "video_length":"15",
    "language": "english",
    "caption": true,
    "avatar_id": 100266,
    "avatar_type":1,
    "script_style": "Don't Worry",
    "template_id":0,
    "voice_id":"en-US-ChristopherNeural",
    "music_id": 62,
    "template_type": "public",
    "override_script": "",
    "caption": true
}
Response example: 
{
    "rid": "864ecc09edbc22041a7312fb4ffb0cd2",
    "code": 0,
    "msg": "success",
    "data": {
        "project_id": "7321782d69884a869400beb255e3ca91"
    }
}

​
Get the generated video

Use the project_id obtained from the “Generate Video from Product Information” step to retrieve details about the video generation, including status and duration. Access the generated video using the video_url. Please refer to the GetGeneratedVideo for the full options of enums. 
curl --location --request GET 'https://api.jogg.ai/v1/project?project_id=fa6228c0f52c4f3986e88f7ffa5d2864' \
--header 'x-api-key: <your-api-key>' \
Response example: 
{
    "rid": "d43b3a5999e31b7e7a62ee5ef84d411d",
    "code": 0,
    "msg": "success",
    "data": {
        "id": "fa6228c0f52c4f3986e88f7ffa5d2864",
        "title": "welcome to jogg.ai",
        "video_url": "https://res.jogg.ai/video.webm",
        "cover_url": "https://res.jogg.ai/cover.png",
        "video_duration": 6,
        "status_code": 4,
        "status_desc": "success",
        "created_at": 1732806631
    }
}